/**
 * Copyright 2006 gworks.com.au
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. (http://www.apache.org/licenses/LICENSE-2.0)
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed 
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for 
 * the specific language governing permissions and limitations under the License.
 *
 * <dhamma-message src="Atisha (11th century Tibetan Buddhist master)">
 * 	The greatest achievement is selflessness. The greatest worth is self-mastery.
 * 	The greatest quality is seeking to serve others. The greatest precept is continual awareness.
 * 	The greatest medicine is the emptiness of everything. The greatest action is not conforming with the worlds ways.
 * 	The greatest magic is transmuting the passions. The greatest generosity is non-attachment.
 * 	The greatest goodness is a peaceful mind. The greatest patience is humility.
 * 	The greatest effort is not concerned with results. The greatest meditation is a mind that lets go.
 * 	The greatest wisdom is seeing through appearances. 
 * </dhamma-message>
 */
package org.javaongems.client.rt.io;

/**
 * <p>Provides the specification for transport listeners which are typically
 * used with http posts. (eg. File upload)</p>
 * <p>Responsibilities: 
 * <ul>
 * 	<li>specification to receive noticifation that a http response has completed
 * 		using one of Gem's alternative transport facilities
 * </ul>
 * </p>
 * <p>Collaborators: [Used by]
 * <ul>
 * 	<li> FileUploadForm - used for uploading content using multiparts
 * </ul>
 * </p>
 * 
 * @see acmware.jump.app.wiki.client.FileUpload
 * 
 * @see com.google.gwt.user.client.HTTPRequest (alternative approach)	 
 * @see com.google.gwt.user.client.ResponseTextHandler (alternative approach)
 * 
 * @author Ashin Wimalajeewa (ash)
 */
public interface TransportListener {
	final static public String HTTP_STATUS_CODE = "gemsHttpStatusCode";
	final static public String HTTP_STATUS_MSG = "gemsHttpStatusMsg";

	/**
	 * invoked when the http response has returned
	 * @param httpStatusCode - a http status code reported by the server
	 * @param httpStatusMsg - an optional message associated with the code
	 */
	public void onCompletion(int httpStatusCode, String httpStatusMsg);
}
